-
Notifications
You must be signed in to change notification settings - Fork 14
Add tutorial in docs about how to use benchmarks #110
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #110 +/- ##
=======================================
Coverage 81.37% 81.37%
=======================================
Files 9 9
Lines 204 204
=======================================
Hits 166 166
Misses 38 38 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
2ef8525 to
bd4e292
Compare
bd4e292 to
7a45bc5
Compare
Co-authored-by: Yoshihiko Ozaki <[email protected]>
y0z
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I leave some comments.
| How to Use Benchmarks | ||
| ===================== | ||
|
|
||
| In this tutorial, we will explain how to use benchmarks in optunahub. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| In this tutorial, we will explain how to use benchmarks in optunahub. | |
| In this tutorial, we will explain how to use benchmarks in OptunaHub. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add some explanation of what OptunaHub Benchmarks is.
It is also helpful to add links to the Medium article (https://medium.com/optuna/optunahub-benchmarks-a-new-feature-to-use-register-various-benchmark-problems-694401524ce0) and how to implement original benchmarks (https://optuna.github.io/optunahub/generated/recipes/006_benchmarks_basic.html, https://optuna.github.io/optunahub/generated/recipes/007_benchmarks_advanced.html).
| :alt: Optimization History | ||
| :align: center | ||
| :width: 800px | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add an example to use OptunaHub Benchmarks with optimizers other than Optuna, like https://medium.com/optuna/optunahub-benchmarks-a-new-feature-to-use-register-various-benchmark-problems-694401524ce0.

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The doc of the evaluate method is here.
| :alt: Optimization History | ||
| :align: center | ||
| :width: 800px | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add an explanation of evaluate_constraints, which allows constrained optimization with optimizers other than Optuna by directly evaluating constraints with user-provided parameters.
Co-authored-by: Yoshihiko Ozaki <[email protected]>
y0z
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Motivation
Guides on benchmarks in OptunaHub would be useful for users.
Description of the changes
I added use cases for normal problem, constrained problem, and multi-objective problem.